Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

oracle.AWXML
Class ForecastArgument

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.ForecastArgument

public class ForecastArgument
extends BaseObject

An argument to a ForecastDefinition. An argument consists of a keyword-value pair. A keyword is represented by a ForeCastKeyWord and the value for the keyword is represented by a ForecastArgumentValue.

For a list of the forecast argument keywords, their valid values, and descriptions of them, see Forecast Argument Keywords and Values.

See Also:
ForecastDefinition

Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL

 

Constructor Summary
ForecastArgument(BaseObject input)
          Creates a ForecastArgument for the specified ForecastDefinition.

 

Method Summary
 ForecastArgumentValue getForecastArgumentValue()
          Gets the ForecastArgumentValue for the ForecastArgument.
 ForeCastKeyWord getForecastKeyWord()
          Gets the ForeCastKeyWord associated with the ForecastArgument.
 void setForecastArgumentValue(ForecastArgumentValue input)
          Specifies the ForecastArgumentValue for the ForecastArgument.
 void setForecastKeyWord(ForeCastKeyWord input)
          Specifies the ForeCastKeyWord for the ForecastArgument.
 void setForecastKeyWord(java.lang.String input)
          Specifies the forecast argument keyword for the ForecastArgument.
 java.lang.String WriteToXML()
          Gets an XML representation of the ForecastArgument.

 

Methods inherited from class oracle.AWXML.BaseObject
Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

ForecastArgument

public ForecastArgument(BaseObject input)
Creates a ForecastArgument for the specified ForecastDefinition.
Parameters:
input - The ForecastDefinition to own the new ForecastArgument.

Method Detail

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the ForecastArgument.
Overrides:
WriteToXML in class BaseObject
Returns:
An XML String that represents the ForecastArgument.

getForecastKeyWord

public ForeCastKeyWord getForecastKeyWord()
Gets the ForeCastKeyWord associated with the ForecastArgument.
Returns:
The ForeCastKeyWord for the ForecastArgument.

setForecastKeyWord

public void setForecastKeyWord(ForeCastKeyWord input)
Specifies the ForeCastKeyWord for the ForecastArgument.
Parameters:
input - The ForeCastKeyWord for the ForecastArgument.

setForecastKeyWord

public void setForecastKeyWord(java.lang.String input)
Specifies the forecast argument keyword for the ForecastArgument. For a list of the forecast argument keywords, see Forecast Argument Keywords and Values.
Parameters:
input - A String that specifies the forecast argument keyword.

setForecastArgumentValue

public void setForecastArgumentValue(ForecastArgumentValue input)
Specifies the ForecastArgumentValue for the ForecastArgument.
Parameters:
input - The ForecastArgumentValue the ForecastArgument.

getForecastArgumentValue

public ForecastArgumentValue getForecastArgumentValue()
Gets the ForecastArgumentValue for the ForecastArgument.
Returns:
The ForecastArgumentValue for the ForecastArgument.

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

Copyright © 2003, 2005 Oracle. All rights reserved.